package com.bkhech.boot.sample.mvc.accesstoken.jwt;

import com.bkhech.boot.sample.mvc.accesstoken.AccessTokenCheckRespDto;
import com.bkhech.boot.sample.mvc.accesstoken.AccessTokenCreateReqDto;
import com.bkhech.boot.sample.mvc.accesstoken.AccessTokenRespDto;

import javax.validation.Valid;

/**
 * TODO JWT Token API 接口
 *
 * @author guowm
 * @date 2023/2/1
 */
public interface JwtTokenApi {

    /**
     * 创建访问令牌
     *
     * @param reqDto 访问令牌的创建信息
     * @return 访问令牌信息
     */
    AccessTokenRespDto createAccessToken(@Valid AccessTokenCreateReqDto reqDto);

    /**
     * 移除访问令牌
     *
     * @param accessToken 访问令牌
     * @return 访问令牌信息
     */
    AccessTokenRespDto removeAccessToken(String accessToken);

    /**
     * 刷新访问令牌
     *
     * @param refreshToken 刷新令牌
     * @param clientId     客户端编号
     * @return 访问令牌信息
     */
    AccessTokenRespDto refreshAccessToken(String refreshToken, String clientId);

    /**
     * 校验访问令牌
     *
     * @param accessToken 访问令牌
     * @return 访问令牌的信息
     */
    AccessTokenCheckRespDto checkAccessToken(String accessToken);

}
